<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: MacToUWBIRPhyControlInfo Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00135.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">MacToUWBIRPhyControlInfo Class Reference<div class="ingroups"><a class="el" href="a00524.html">IEEE 802.15.4A - Classes that implement the IEEE 802.15.4A UWB PHY.</a> &#124; <a class="el" href="a00510.html">phyLayer - physical layer modules</a> &#124; <a class="el" href="a00509.html">macLayer - MAC layer modules</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="MacToUWBIRPhyControlInfo" --><!-- doxytag: inherits="MacToPhyControlInfo" -->
<p>This control info allows to store the <a class="el" href="a00099.html" title="This class regroups static methods needed to generate a pulse-level representation of an IEEE 802...">IEEE802154A</a> config parameters that were used to generate the accompanying signal.  
 <a href="a00135.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00472_source.html">MacToUWBIRPhyControlInfo.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for MacToUWBIRPhyControlInfo:</div>
<div class="dyncontent">
<div class="center"><img src="a00848.png" border="0" usemap="#MacToUWBIRPhyControlInfo_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for MacToUWBIRPhyControlInfo:</div>
<div class="dyncontent">
<div class="center"><img src="a00849.png" border="0" usemap="#MacToUWBIRPhyControlInfo_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00850.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69accfd1326a7276561a8fb10b73c998"></a><!-- doxytag: member="MacToUWBIRPhyControlInfo::MacToUWBIRPhyControlInfo" ref="a69accfd1326a7276561a8fb10b73c998" args="(Signal *signal=0, const IEEE802154A::config &amp;cfg=IEEE802154A::cfg_mandatory_16M)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>MacToUWBIRPhyControlInfo</b> (<a class="el" href="a00192.html">Signal</a> *<a class="el" href="a00133.html#a05a564d743e50aa370ee796ee932c8a6">signal</a>=0, const <a class="el" href="a00051.html">IEEE802154A::config</a> &amp;cfg=IEEE802154A::cfg_mandatory_16M)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac66a3e0c04412f2f8753f6a77d97981e"></a><!-- doxytag: member="MacToUWBIRPhyControlInfo::getConfig" ref="ac66a3e0c04412f2f8753f6a77d97981e" args="() const " -->
const <a class="el" href="a00051.html">IEEE802154A::config</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getConfig</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static cObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#ac8d6c911d43d20157843abb105d84764">setControlInfo</a> (cMessage *const pMsg, <a class="el" href="a00192.html">Signal</a> *const pSignal, const <a class="el" href="a00051.html">IEEE802154A::config</a> &amp;pConfig=IEEE802154A::cfg_mandatory_16M)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches a "control info" structure (object) to the message pMsg.  <a href="#ac8d6c911d43d20157843abb105d84764"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa989c47bc332dfd13d2af6ba6f2e9555"></a><!-- doxytag: member="MacToUWBIRPhyControlInfo::getSignalFromControlInfo" ref="aa989c47bc332dfd13d2af6ba6f2e9555" args="(cObject *const pCtrlInfo)" -->
static <a class="el" href="a00192.html">Signal</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#aa989c47bc332dfd13d2af6ba6f2e9555">getSignalFromControlInfo</a> (cObject *const pCtrlInfo)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">extracts the signal from "control info". <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a227d8c2e990f594fe6b9828d40011572"></a><!-- doxytag: member="MacToUWBIRPhyControlInfo::getConfigFromControlInfo" ref="a227d8c2e990f594fe6b9828d40011572" args="(cObject *const pCtrlInfo)" -->
static const <a class="el" href="a00051.html">IEEE802154A::config</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html#a227d8c2e990f594fe6b9828d40011572">getConfigFromControlInfo</a> (cObject *const pCtrlInfo)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">extracts the signal from "control info". <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c3a12d58859d94b06e713201ec7e95e"></a><!-- doxytag: member="MacToUWBIRPhyControlInfo::cfg" ref="a7c3a12d58859d94b06e713201ec7e95e" args="" -->
<a class="el" href="a00051.html">IEEE802154A::config</a>&#160;</td><td class="memItemRight" valign="bottom"><b>cfg</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This control info allows to store the <a class="el" href="a00099.html" title="This class regroups static methods needed to generate a pulse-level representation of an IEEE 802...">IEEE802154A</a> config parameters that were used to generate the accompanying signal. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac8d6c911d43d20157843abb105d84764"></a><!-- doxytag: member="MacToUWBIRPhyControlInfo::setControlInfo" ref="ac8d6c911d43d20157843abb105d84764" args="(cMessage *const pMsg, Signal *const pSignal, const IEEE802154A::config &amp;pConfig=IEEE802154A::cfg_mandatory_16M)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static cObject* MacToUWBIRPhyControlInfo::setControlInfo </td>
          <td>(</td>
          <td class="paramtype">cMessage *const&#160;</td>
          <td class="paramname"><em>pMsg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00192.html">Signal</a> *const&#160;</td>
          <td class="paramname"><em>pSignal</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00051.html">IEEE802154A::config</a> &amp;&#160;</td>
          <td class="paramname"><em>pConfig</em> = <code>IEEE802154A::cfg_mandatory_16M</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Attaches a "control info" structure (object) to the message pMsg. </p>
<p>This is most useful when passing packets between protocol layers of a protocol stack, the control info will contain the signal.</p>
<p>The "control info" object will be deleted when the message is deleted. Only one "control info" structure can be attached (the second setL3ToL2ControlInfo() call throws an error).</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pMsg</td><td>The message where the "control info" shall be attached. </td></tr>
    <tr><td class="paramname">pSignal</td><td>The signal which should be send. </td></tr>
  </table>
  </dd>
</dl>
<div class="fragment"><pre class="fragment">                                                                                                                                                    {
        <a class="code" href="a00135.html" title="This control info allows to store the IEEE802154A config parameters that were used to generate the ac...">MacToUWBIRPhyControlInfo</a> *<span class="keyword">const</span> cCtrlInfo = <span class="keyword">new</span> <a class="code" href="a00135.html" title="This control info allows to store the IEEE802154A config parameters that were used to generate the ac...">MacToUWBIRPhyControlInfo</a>(pSignal, pConfig);
        pMsg-&gt;setControlInfo(cCtrlInfo);

        <span class="keywordflow">return</span> cCtrlInfo;
      }
</pre></div>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/modules/phy/<a class="el" href="a00472_source.html">MacToUWBIRPhyControlInfo.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00135.html">MacToUWBIRPhyControlInfo</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:32 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
